Records the entered time for the truck visit. Use this business task at the Truck Visit IN gate stage just prior to the yard to record when a truck enters the yard.
|
Gate stage |
|
Truck Visit IN |
The business task sets the truck visit status as Departed after the last gate stage is completed successfully.
Functional Area
Gate
Execution Level
Truck Visit
Transaction Type(s)
Truck Visit OUT
Timing
For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:
pre-stage: The business task is processed when the truck arrives at a gate stage and validates whether the truck is at the correct gate stage.
N4 processes this business task when creating a truck visit or when you click the Save Transaction button on the <GateStage> tab for the first gate transaction.
If any pre-stage business task fails at the first gate stage, N4 does not create a truck visit, and does not allow the user to send the truck to Trouble.
on-arrival: The business task is processed when the truck arrives at the Exchange area. N4 processes this task when you click on the Confirm Arrival button at the bottom of the <GateStage> tab or process the notify-arrival API.
The Confirm Arrival button is available only if you have included an on-arrival business task in your truck visit configuration and the Stage Type of the gate stage is Out-gate Stage. Clicking this button also triggers the EC event TV_ITZ_LANE_ARRIVAL.
on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).
validation: The business task is executed when a truck visit is created after successful execution of the pre-stage business tasks, but before the execution of the on-submit business tasks.
If a validation business task fails, N4 creates the truck visit and allows the user to send the truck visit to Trouble to be resolved later.
on-trouble: The business task is executed when the truck is sent to Trouble.
area-done: The business task is executed when N4 determines that all the gate transactions for the truck visit that were for this exchange area are done at the yard stage.
This gate work flow is executed when either of the following conditions is true:
N4 receives an area-done message through the API.
A clerk successfully Saves the last gate transaction for the yard stage at this exchange area and before the clerk clicks the Proceed to Next Stage button for the truck from a gate form.
As the final step in a process-truck API message when all transactions have been submitted.
Automatically from the transaction-level on-submit workflow if the stage is configured to check if all transactions are submitted for that stage. If the transaction-level on-submit workflow passes successfully, N4 checks whether this is the last transaction to be submitted during this visit to an exchange area, meaning that the next transaction, which has not yet been submitted at this stage, is for a different exchange area. If this is the last transaction submitted at the stage, then N4 considers it the last transaction at the exchange area. If the exchange area is null, either because it is a non-exchange area move in a terminal that has exchange areas or the terminal has no exchange areas, then null is treated like any other individual exchange area value.
Client Type(s)
UI and Gate API
Parameters
None
Dependencies
None
Related Business Task(s)
CreateUnitDeparting (on page 1)
DepartUnit (on page 1)
Custom Code
Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.
Field(s)
None
The business task rejects a gate transaction if the truck visit is a duplicate truck visits based on the Driver Card ID, Truck License, or Truck ID. When you include this business task and a clerk tries to create two open truck visits with the same driver information, N4 displays an error message.
This business task takes care of a problem that occurs during the scanning process at the gate that results in the creation of duplicate truck visits with the same driver. For example, when using polling, N4 scanned the Driver Card ID and displayed it in more than one gate form, possibly because there were two N4 gate forms open. After processing this first truck, the next driver shows up and swipes his card. However, N4 does not acknowledge this because the previous driver's information is already populated in the gate form. If you include this business task in your gate configuration, it prevents the gate clerk from creating a gate transaction for the next truck using the previous driver's information.
Functional Area
Appointment and Gate
Execution Level
Transaction/Truck Visit
Transaction Type(s)
Appointment: Deliver Chassis (DC), Dray Off (DE), Deliver Import (DI), Deliver Empty (DM), Receive Break-Bulk (RB), Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Through Container (TC)
Gate: Deliver Break-Bulk (DB), Deliver Chassis (DC), Dray Off (DE), Deliver Import (DI), Deliver Empty (DM), Receive Break-Bulk (RB), Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Through Container (TC)
Truck Visit IN, Truck Visit OUT, Truck Visit APPTTV
Timing
For gate transactions, such as Receive Export or Receive Empty, N4 processes tasks when you click the Save Transaction button on the gate transaction section of the <GateStage> tab (on page 1).
For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:
on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).
validation: The business task is executed when a truck visit is created after successful execution of the pre-stage business tasks, but before the execution of the on-submit business tasks.
If a validation business task fails, N4 creates the truck visit and allows the user to send the truck visit to Trouble to be resolved later.
For appointments, N4 processes business tasks on two occasions:
If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).
If the business task is included in the Include Dispatch column, N4 processes it when you click Save after associating the appointment with a truck visit appointment.
For truck visit appointments, N4 processes the business tasks when you click Save in the Truck Visit Appointment form (on page 1).
Client Type(s)
UI and Gate API
Parameters
None
Dependencies
None
Related Business Task(s)
None
Custom Code
Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.
Field(s)
None
The business task rejects a gate transaction and prevents N4 from creating a truck visit if you do not specify any of the business identifiers, such as the Truck License, Truck ID, Driver Card ID, or the Tag ID, for the truck.
You must include this business task at the earliest stage where at least one of these values is provided. Typically, this is the first stage of the gate flow.
You may exclude this business task to allow for circumstances where you want the gate system to create a truck visit even without the business information either because it is not available at that point or because of scan failures.
Functional Area
Appointment and Gate
Execution Level
Truck Visit and Transaction
Transaction Type(s)
Appointment: Deliver Break-Bulk (DB), Deliver Chassis (DC), Dray Off (DE), Deliver Import (DI), Deliver Empty (DM), Receive Break-Bulk (RB), Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Through Container (TC), Unknown (UK)
Truck Visit IN, Truck Visit OUT, Truck Visit APPTTV
Gate: Deliver Break-Bulk (DB), Deliver Chassis (DC), Dray Off (DE), Deliver Import (DI), Deliver Empty (DM), Receive Break-Bulk (RB), Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Through Container (TC), Unknown (UK)
Truck Visit IN, Truck Visit OUT, Truck Visit APPTTV
Client Type(s)
UI and Gate API
Parameters
None
Dependencies
None
Related Business Task(s)
None
Custom Code
Any custom code defined for the business task is executed at the end of this business task and has no impact on the execution of the business task.
Field(s)
None
|
Functional Area |
Gate |
|
Execution Level |
Truck Visit |
|
Transaction Type(s) |
Gate: Truck Visit IN |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
ReplanUnitsIntoYard (on page 1) |
|
Field(s) |
None |
Description
The business task resequences/reorders the gate transactions associated with a truck visit to minimize truck hopping and shares the sequence information with XPS.
When sequencing the gate transactions associated with a truck visit, the following order is used:
Receivals have the lowest sequence numbers and increase according to the position-on-truck from back to the front/cab.
Deliveries are sequenced according to the planned position-on-truck from front/cab to the back of the chassis.
Parameters
None
Dependencies
You must include the ReplanUnitsIntoYard (on page 1) business task to change the sequence of the gate transactions associated with the truck visit.
Timing
For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:
on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).
Custom Code
Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.
|
Functional Area |
Gate |
|
Execution Level |
Transaction/Truck Visit |
|
Transaction Type(s) |
Gate: Truck Visit IN, Truck Visit OUT |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
None |
|
Field(s) |
None |
Description
When you include this business task for a truck visit transaction at the gate stage and add the custom code extension of type GATE_TASK_INTERCEPTOR and name GateInterceptorStopOnBadPositionMessage in the Custom column and post the notify-arrival API message for the Deliver Import transaction with an incorrect lane ID, N4 displays an error message in the response API message as specified in the code extension. N4 does not assign the truck to the incorrect lane.
Parameters
None
Dependencies
None
Timing
For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form.
accept-msg: This task is executed when you process the notify-arrival API with the lane ID during the truck visit transaction.
Custom Code
Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.
|
Functional Area |
Appointment |
|
Execution Level |
Truck Visit |
|
Transaction Type(s) |
Appointment: Truck Visit APPTTV |
|
Client Type(s) |
UI and Gate API |
|
Related Business Task(s) |
RejectAppointmentIDOExpired (on page 1) |
|
Field(s) |
None |
Description
When included in the appointment stage at the truck visit level, the business task rejects the truck visit appointment if the truck visit appointment requested date is after the IDO expiry date of the associated unit.
Parameters
None
Dependencies
None
Timing
For appointments, N4 processes business tasks on two occasions:
If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form.
If the business task is included in the Include Dispatch column, N4 processes it when you click Save after associating the appointment with a truck visit appointment.
For truck visit appointments, N4 processes the business tasks when you click Save in the Truck Visit Appointment form.
Custom Code
Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.